home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / biblio / bibtex / utils / bibextract / citefind.man < prev    next >
Text File  |  1992-10-29  |  5KB  |  146 lines
  1. .\" ====================================================================
  2. .\"  @Troff-man-file{
  3. .\"     author          = "Nelson H. F. Beebe",
  4. .\"     version         = "1.02",
  5. .\"     date            = "30 October 1992",
  6. .\"     time            = "19:41:15 MST",
  7. .\"     filename        = "citefind.man",
  8. .\"     address         = "Center for Scientific Computing
  9. .\"                        Department of Mathematics
  10. .\"                        University of Utah
  11. .\"                        Salt Lake City, UT 84112
  12. .\"                        USA",
  13. .\"     telephone       = "+1 801 581 5254",
  14. .\"     FAX             = "+1 801 581 4148",
  15. .\"     checksum        = "43423 145 595 4865",
  16. .\"     email           = "beebe@math.utah.edu (Internet)",
  17. .\"     codetable       = "ISO/ASCII",
  18. .\"     keywords        = "bibliography, BibTeX",
  19. .\"     supported       = "yes",
  20. .\"     docstring       = "This file contains the UNIX manual pages
  21. .\"                        for the citefind command, a shell script
  22. .\"                        that invokes an awk program to extract from
  23. .\"                        a list of BibTeX .bib files bibliography
  24. .\"                        entries that match a specified list of
  25. .\"                        citation tags, possibly produced by
  26. .\"                        citetags(1).
  27. .\"
  28. .\"                        The checksum field above contains a CRC-16
  29. .\"                        checksum as the first value, followed by the
  30. .\"                        equivalent of the standard UNIX wc (word
  31. .\"                        count) utility output of lines, words, and
  32. .\"                        characters.  This is produced by Robert
  33. .\"                        Solovay's checksum utility.",
  34. .\"  }
  35. .\" ====================================================================
  36. .if t .ds Bi B\s-2IB\s+2T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X
  37. .if n .ds Bi BibTeX
  38. .if t .ds Te T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X
  39. .if n .ds Te TeX
  40. .TH CITEFIND 1 "30 October 1992" "Version 1.02"
  41. .\"======================================================================
  42. .SH NAME
  43. citefind \- extract matching bibliography entries from BibTeX .bib files
  44. .\"======================================================================
  45. .SH SYNOPSIS
  46. .nf
  47. .BI citefind " tags-file bibfile(s) >newbibfile"
  48. .fi
  49. or
  50. .nf
  51. .BI citefind " \- bibfile(s) >newbibfile"
  52. .fi
  53. .\"======================================================================
  54. .SH DESCRIPTION
  55. .B citefind
  56. extracts from a list of \*(Bi\&
  57. .I .bib
  58. files those bibliography entries that match a
  59. specified list of citation tags, possibly produced
  60. by
  61. .BR citetags (1),
  62. sending the entries to
  63. .IR stdout ,
  64. together with all \*(Bi\& ``@Preamble{.\|.\|.}''
  65. and ``@String{.\|.\|.}'' commands.
  66. .PP
  67. If the first argument,
  68. .IR tags-file ,
  69. is ``\-'', the tag list is read from
  70. .IR stdin ,
  71. allowing it to be piped from
  72. .BR citetags (1).
  73. .PP
  74. Bibliography entries are output in the order found
  75. in the
  76. .I .bib
  77. files.  In the absence of cross references, you
  78. may be able to use
  79. .BR bibsort (1)
  80. to sort them by citation key.  While such sorting
  81. is unnecessary for \*(Bi\& itself, it is
  82. convenient for a human reader of the
  83. .I .bib
  84. file.
  85. .PP
  86. When documents are prepared using a large
  87. bibliography data base collection, it is sometimes
  88. convenient to extract a subset \*(Bi\&
  89. bibliography file incorporating only those entries
  90. that are cited in the document.  A good example is
  91. a document to be submitted to a publisher, or
  92. otherwise distributed in electronic form.
  93. .\"======================================================================
  94. .SH "BUGS"
  95. .B citefind
  96. is not smart enough to incorporate \*(Bi\&
  97. cross references unless their citation tags are
  98. included in the input list.
  99. .PP
  100. No attempt is made to reduce the output
  101. ``@String{.\|.\|.}'' commands to just those that
  102. are actually referenced.
  103. .PP
  104. Those features should be added.
  105. .\"======================================================================
  106. .SH "SEE ALSO"
  107. .BR bibclean (1),
  108. .BR bibextract (1),
  109. .BR bibindex (1),
  110. .BR biblook (1),
  111. .BR bibsort (1),
  112. .BR bibtex (1),
  113. .BR citetags (1).
  114. .\"======================================================================
  115. .SH FILES
  116. .\" NB: LIBDIR and BINDIR are substituted for real directory names
  117. .\"     by a sed script invoked by "make install".
  118. .TP \w'@LIBDIR@/citefind.awk'u+2n
  119. @LIBDIR@/citefind.awk
  120. .BR nawk (1)
  121. program for tag extraction.
  122. .TP
  123. @BINDIR@/citefind
  124. user-callable shell script to invoke
  125. .BR nawk (1).
  126. .\"======================================================================
  127. .SH AUTHOR
  128. Nelson H. F. Beebe, Ph.D.
  129. .br
  130. Center for Scientific Computing
  131. .br
  132. Department of Mathematics
  133. .br
  134. University of Utah
  135. .br
  136. Salt Lake City, UT 84112
  137. .br
  138. USA
  139. .br
  140. Tel: +1 801 581 5254
  141. .br
  142. FAX: +1 801 581 4148
  143. .br
  144. Email: <beebe@math.utah.edu>
  145. .\"==============================[The End]==============================
  146.